home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / lib.fmt / c / stat.man < prev    next >
Encoding:
Text File  |  1989-01-04  |  7.3 KB  |  199 lines
  1.  
  2.  
  3.  
  4. STAT                  C Library Procedures                   STAT
  5.  
  6.  
  7.  
  8. NNAAMMEE
  9.      stat, lstat, fstat - get file status
  10.  
  11. SSYYNNOOPPSSIISS
  12.      ##iinncclluuddee <<ssyyss//ttyyppeess..hh>>
  13.      ##iinncclluuddee <<ssyyss//ssttaatt..hh>>
  14.  
  15.      ssttaatt((ppaatthh,, bbuuff))
  16.      cchhaarr **ppaatthh;;
  17.      ssttrruucctt ssttaatt **bbuuff;;
  18.  
  19.      llssttaatt((ppaatthh,, bbuuff))
  20.      cchhaarr **ppaatthh;;
  21.      ssttrruucctt ssttaatt **bbuuff;;
  22.  
  23.      ffssttaatt((ffdd,, bbuuff))
  24.      iinntt ffdd;;
  25.      ssttrruucctt ssttaatt **bbuuff;;
  26.  
  27. DDEESSCCRRIIPPTTIIOONN
  28.      _S_t_a_t obtains information about the file _p_a_t_h.  Read, write
  29.      or execute permission of the named file is not required, but
  30.      all directories listed in the path name leading to the file
  31.      must be reachable.
  32.  
  33.      _L_s_t_a_t is like _s_t_a_t except in the case where the named file
  34.      is a symbolic link, in which case _l_s_t_a_t returns information
  35.      about the link, while _s_t_a_t returns information about the
  36.      file the link references.
  37.  
  38.      _F_s_t_a_t obtains the same information about an open file refer-
  39.      enced by the argument descriptor, such as would be obtained
  40.      by an _o_p_e_n call.
  41.  
  42.      _B_u_f is a pointer to a _s_t_a_t structure into which information
  43.      is placed concerning the file.  The contents of the struc-
  44.      ture pointed to by _b_u_f
  45.  
  46.           struct stat {
  47.                dev_t  st_dev;      /* device inode resides on */
  48.                ino_t  st_ino;      /* this inode's number */
  49.                u_short             st_mode;/* protection */
  50.                short  st_nlink;    /* number or hard links to the file */
  51.                uid_t  st_uid;      /* user-id of owner */
  52.                gid_t  st_gid;      /* group-id of owner */
  53.                dev_t  st_rdev;     /* the device type, for inode that is device */
  54.                off_t  st_size;     /* total size of file */
  55.                time_t st_atime;    /* file last access time */
  56.                int    st_spare1;
  57.                time_t st_mtime;    /* file last modify time */
  58.                int    st_spare2;
  59.                time_t st_ctime;    /* file last status change time */
  60.  
  61.  
  62.  
  63. Sprite v1.0             October 25, 1987                        1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. STAT                  C Library Procedures                   STAT
  71.  
  72.  
  73.  
  74.                int    st_spare3;
  75.                long   st_blksize;  /* optimal blocksize for file system i/o ops */
  76.                long   st_blocks;   /* actual number of blocks allocated */
  77.                long   st_serverID; /* Sprite ID of server holding inode */
  78.                long   st_version;  /* Version number for file */
  79.                long   st_userType; /* User-settable attribute word */
  80.                long   st_devServerID;/* For devices, Sprite ID of device's machine */
  81.          };
  82.  
  83.      st_atime    Time when file data was last accessed.  Changed
  84.                  by the following system calls: _m_k_n_o_d(2),
  85.                  _u_t_i_m_e_s(2), and _r_e_a_d(2).  For directories, the
  86.                  access time is changed each time a file name
  87.                  lookup passes through the directory.
  88.  
  89.      st_mtime    Time when data was last modified.  It is not set
  90.                  by changes of owner, group, link count, or mode.
  91.                  Changed by the following system calls: _m_k_n_o_d(2),
  92.                  _u_t_i_m_e_s(2), _w_r_i_t_e(2).
  93.  
  94.      st_ctime    Time when file status was last changed.  It is
  95.                  set both both by writing and changing the i-
  96.                  node.  Changed by the following system calls:
  97.                  _c_h_m_o_d(2) _c_h_o_w_n(2), _l_i_n_k(2), _m_k_n_o_d(2), _r_e_n_a_m_e(2),
  98.                  _u_n_l_i_n_k(2), _u_t_i_m_e_s(2), _w_r_i_t_e(2).
  99.  
  100.      st_version  Version number for the file.  It is incremented
  101.                  each time the file is opened for writing.
  102.  
  103.      The status information word _s_t__m_o_d_e has bits:
  104.           #define S_IFMT  0170000  /* type of file */
  105.           #define    S_IFDIR       0040000/* directory */
  106.           #define    S_IFCHR       0020000/* character special */
  107.           #define    S_IFBLK       0060000/* block special */
  108.           #define    S_IFREG       0100000/* regular */
  109.           #define    S_IFLNK       0120000/* symbolic link */
  110.           #define    S_IFSOCK      0140000/* socket */
  111.           #define    S_IFPDEV      0150000/* pseudo-device */
  112.           #define    S_IFRLNK      0160000/* remote link */
  113.           #define S_ISUID 0004000  /* set user id on execution */
  114.           #define S_ISGID 0002000  /* set group id on execution */
  115.           #define S_IREAD 0000400  /* read permission, owner */
  116.           #define S_IWRITE         0000200/* write permission, owner */
  117.           #define S_IEXEC 0000100  /* execute/search permission, owner */
  118.  
  119.      The mode bits 0000070 and 0000007 encode group and others
  120.      permissions (see _c_h_m_o_d(2)).
  121.  
  122. RREETTUURRNN VVAALLUUEE
  123.      Upon successful completion a value of 0 is returned.  Other-
  124.      wise, a value of -1 is returned and _e_r_r_n_o is set to indicate
  125.      the error.
  126.  
  127.  
  128.  
  129. Sprite v1.0             October 25, 1987                        2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. STAT                  C Library Procedures                   STAT
  137.  
  138.  
  139.  
  140. EERRRROORRSS
  141.      _S_t_a_t and _l_s_t_a_t will fail if one or more of the following are
  142.      true:
  143.  
  144.      [ENOTDIR]      A component of the path prefix is not a
  145.                     directory.
  146.  
  147.      [EINVAL]       The pathname contains a character with the
  148.                     high-order bit set.
  149.  
  150.      [ENAMETOOLONG] A component of a pathname exceeded 255 char-
  151.                     acters, or an entire path name exceeded 1023
  152.                     characters.
  153.  
  154.      [ENOENT]       The named file does not exist.
  155.  
  156.      [EACCES]       Search permission is denied for a component
  157.                     of the path prefix.
  158.  
  159.      [ELOOP]        Too many symbolic links were encountered in
  160.                     translating the pathname.
  161.  
  162.      [EFAULT]       _B_u_f or _n_a_m_e points to an invalid address.
  163.  
  164.      [EIO]          An I/O error occurred while reading from or
  165.                     writing to the file system.
  166.  
  167.      _F_s_t_a_t will fail if one or both of the following are true:
  168.  
  169.      [EBADF]        _F_i_l_d_e_s is not a valid open file descriptor.
  170.  
  171.      [EFAULT]       _B_u_f points to an invalid address.
  172.  
  173.      [EIO]          An I/O error occurred while reading from or
  174.                     writing to the file system.
  175.  
  176. CCAAVVEEAATT
  177.      The fields in the stat structure currently marked _s_t__s_p_a_r_e_1,
  178.      _s_t__s_p_a_r_e_2, and _s_t__s_p_a_r_e_3 are present in preparation for
  179.      inode time stamps expanding to 64 bits.  This, however, can
  180.      break certain programs that depend on the time stamps being
  181.      contiguous (in calls to _u_t_i_m_e_s(2)).
  182.  
  183. SSEEEE AALLSSOO
  184.      chmod(2), chown(2), utimes(2)
  185.  
  186. BBUUGGSS
  187.      Applying _f_s_t_a_t to a socket (and thus to a pipe) returns a
  188.      zero'd buffer, except for the blocksize field, and a unique
  189.      device and inode number.
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Sprite v1.0             October 25, 1987                        3
  196.  
  197.  
  198.  
  199.